Summary

Fully Qualified Name:	Laminas\Hydrator\ClassMethodsHydrator
Extends:	AbstractHydrator
Implements:	HydratorOptionsInterface

Description

Methods

Name	Description	Defined By
__construct()	Define if extract values will use camel case or name with underscore	ClassMethodsHydrator
addFilter()	{@inheritDoc}	ClassMethodsHydrator
addStrategy()	Adds the given strategy under the given name.	AbstractHydrator
extract()	Extract values from an object with class methods	ClassMethodsHydrator
extractName()	Convert a name for extraction. If no naming strategy exists, the plain value is returned.	AbstractHydrator
extractValue()	Converts a value for extraction. If no strategy exists the plain value is returned.	AbstractHydrator
getFilter()	Get the filter instance	AbstractHydrator
getMethodExistsCheck()		ClassMethodsHydrator
getNamingStrategy()	Gets the naming strategy.	AbstractHydrator
getStrategy()	Gets the strategy with the given name.	AbstractHydrator
getUnderscoreSeparatedKeys()		ClassMethodsHydrator
hasFilter()	Check whether a specific filter exists at key $name or not	AbstractHydrator
hasNamingStrategy()	Checks if a naming strategy exists.	AbstractHydrator
hasStrategy()	Checks if the strategy with the given name exists.	AbstractHydrator
hydrate()	Hydrate an object by populating getter/setter methods	ClassMethodsHydrator
hydrateName()	Converts a value for hydration. If no naming strategy exists, the plain value is returned.	AbstractHydrator
hydrateValue()	Converts a value for hydration. If no strategy exists the plain value is returned.	AbstractHydrator
removeFilter()	{@inheritDoc}	ClassMethodsHydrator
removeNamingStrategy()	{@inheritDoc}	ClassMethodsHydrator
removeStrategy()	Removes the strategy with the given name.	AbstractHydrator
setMethodExistsCheck()		ClassMethodsHydrator
setNamingStrategy()	{@inheritDoc}	ClassMethodsHydrator
setOptions()		ClassMethodsHydrator
setUnderscoreSeparatedKeys()		ClassMethodsHydrator

Method Details

__construct()

Define if extract values will use camel case or name with underscore

Parameter Name	Type	Description
$underscoreSeparatedKeys
$methodExistsCheck

Returns:

addFilter()

{@inheritDoc}

Parameter Name	Type	Description
$name
$filter
$condition

Returns:

addStrategy()

Adds the given strategy under the given name.

Parameter Name	Type	Description
$name	string	The
$strategy	\Strategy\StrategyInterface	The

Returns:

extract()

Extract values from an object with class methods

Extracts the getter/setter of the given $object.

{@inheritDoc}

Parameter Name	Type	Description
$object

Returns:

extractName()

Convert a name for extraction. If no naming strategy exists, the plain value is returned.

Parameter Name	Type	Description
$name	string	The
$object	null|object	The

Returns: mixed

extractValue()

Converts a value for extraction. If no strategy exists the plain value is returned.

Parameter Name	Type	Description
$name	string	The
$value	mixed	The
$object	null|object	The

Returns: mixed

getFilter()

Get the filter instance

Returns:

getMethodExistsCheck()

Returns: void

getNamingStrategy()

Gets the naming strategy.

If no naming strategy is registered, registers the IdentityNamingStrategy, which acts essentially as a no-op.

{@inheritDoc}

Returns:

getStrategy()

Gets the strategy with the given name.

Parameter Name	Type	Description
$name	string	The

Returns:

getUnderscoreSeparatedKeys()

Returns: void

hasFilter()

Check whether a specific filter exists at key $name or not

Parameter Name	Type	Description
$name	string	Index/name

Returns:

hasNamingStrategy()

Checks if a naming strategy exists.

Returns:

hasStrategy()

Checks if the strategy with the given name exists.

Parameter Name	Type	Description
$name	string	The

Returns:

hydrate()

Hydrate an object by populating getter/setter methods

Hydrates an object by getter/setter methods of the object.

{@inheritDoc}

Parameter Name	Type	Description
$data
$object

Returns:

hydrateName()

Converts a value for hydration. If no naming strategy exists, the plain value is returned.

Parameter Name	Type	Description
$name	string	The
$data	null|array	The

Returns:

hydrateValue()

Converts a value for hydration. If no strategy exists the plain value is returned.

Parameter Name	Type	Description
$name	string	The
$value	mixed	The
$data	null|array	The

Returns: mixed

removeFilter()

{@inheritDoc}

Parameter Name	Type	Description
$name

Returns:

removeNamingStrategy()

{@inheritDoc}

Returns:

removeStrategy()

Removes the strategy with the given name.

Parameter Name	Type	Description
$name	string	The

Returns:

setMethodExistsCheck()

Parameter Name	Type	Description
$methodExistsCheck

Returns: void

setNamingStrategy()

{@inheritDoc}

Parameter Name	Type	Description
$strategy

Returns:

setOptions()

Parameter Name	Type	Description
$options	array

Returns:

setUnderscoreSeparatedKeys()

Parameter Name	Type	Description
$underscoreSeparatedKeys

Returns: void